Add IP address preference support for TCP connection #1015

karinazhou · 2021-03-31T23:17:51Z

A new connection property IPAddressPreference is added to specify the IP preference by the client application when doing TCP connection. There are three valid types:

IPv4First
This is the default preference. The driver will traverse IPv4 addresses first. If none of them can be connected successfully, it continues to try IPv6 addresses if there are any.
IPv6First
The driver will traverse IPv6 addresses first. If none of them can be connected successfully, it continues to try IPv4 addresses if there are any.
UsePlatformDefault
The driver will traverse all the IP addresses in their initial orders from DNS resolution.

To keep the consistency between managed SNI and native SNI, the connection logic is changed in SNITcpHandle:Connect(). Instead of keeping the last IPv4 and IPv6 addresses, all the valid IP addresses returned from DNS resolution will be tested in a row. There will be a separate PR containing this change in parallel.

NOTE: This PR requires the change in native SNI so it requires a new version of Microsoft.Data.SqlClient.SNI to be released first.

cc @johnnypham @cheenamalhotra @David-Engel @saurabh500

…ressPreference

src/Microsoft.Data.SqlClient/netcore/src/Interop/SNINativeMethodWrapper.Windows.cs

doc/snippets/Microsoft.Data.SqlClient/SqlConnectionIPAddressPreference.xml

doc/snippets/Microsoft.Data.SqlClient/SqlConnectionStringBuilder.xml

src/Microsoft.Data.SqlClient/netcore/src/Microsoft/Data/SqlClient/SNI/SNITcpHandle.cs

doc/snippets/Microsoft.Data.SqlClient/SqlConnectionIPAddressPreference.xml

doc/snippets/Microsoft.Data.SqlClient/SqlConnectionStringBuilder.xml

Wraith2 · 2021-04-02T16:44:08Z

I had a talk to someone with some networking experience and they pointed out that many applications will use addresses in the order returned from dns to connect to resources and so the first ip address in a list is likely to be the most connected route. This means that seemingly arbitrary choice of the last ip of each type may have been a deliberate attempt to choose the least used route. If this is true then that should have been called out in the code with a comment.

I think trying each address returned in the order that they are returned will be more compatible with dns based load balancing schemes. When you look at parallelizing the connections you may want to keep track of the original ordering and when two connections succeed choose the first using the original ordering.

Co-authored-by: David Engel <dengel1012@gmail.com>

…qlClient into IPAddressPreference

src/Microsoft.Data.SqlClient/netcore/src/Microsoft/Data/SqlClient/SNI/SNITcpHandle.cs

…ent/SNI/SNITcpHandle.cs

# Conflicts: # src/Microsoft.Data.SqlClient/tests/ManualTests/Microsoft.Data.SqlClient.ManualTesting.Tests.csproj

BUILDGUIDE.md

This reverts commit 5642e74.

src/Microsoft.Data.SqlClient/netcore/src/Microsoft/Data/Common/DbConnectionStringCommon.cs

src/Microsoft.Data.SqlClient/netcore/src/Microsoft/Data/SqlClient/SNI/SNITcpHandle.cs

src/Microsoft.Data.SqlClient/netcore/src/Microsoft/Data/Common/DbConnectionStringCommon.cs

src/Microsoft.Data.SqlClient/netcore/src/Resources/Strings.Designer.cs

src/Microsoft.Data.SqlClient/netfx/src/Microsoft/Data/SqlClient/SqlConnection.cs

src/Microsoft.Data.SqlClient/netcore/src/Microsoft/Data/SqlClient/SqlConnection.cs

Co-authored-by: Javad <v-jarahn@microsoft.com> Co-authored-by: Cheena Malhotra <v-chmalh@microsoft.com>

src/Microsoft.Data.SqlClient/netcore/src/Microsoft/Data/Common/DbConnectionStringCommon.cs

src/Microsoft.Data.SqlClient/netcore/src/Microsoft/Data/SqlClient/SNI/SNITcpHandle.cs

src/Microsoft.Data.SqlClient/netcore/src/Microsoft/Data/SqlClient/SqlConnectionString.cs

src/Microsoft.Data.SqlClient/netcore/src/Microsoft/Data/SqlClient/SqlConnectionStringBuilder.cs

+ improvement

Co-authored-by: Cheena Malhotra <v-chmalh@microsoft.com>

Wraith2 · 2021-05-11T23:47:25Z

src/Microsoft.Data.SqlClient/netcore/src/Microsoft/Data/Common/DbConnectionStringCommon.cs

+ string sValue = (value as string);
+ if (sValue is not null)


Can this be if (value is string sValue) ? the is operator does the type and null checks so it's known to be a non-null string inside the if block if the condition returns true.

src/Microsoft.Data.SqlClient/netcore/src/Resources/Strings.Designer.cs

src/Microsoft.Data.SqlClient/netfx/src/Resources/Strings.Designer.cs

+ modify CancelAsyncConnections test

doc/snippets/Microsoft.Data.SqlClient/SqlConnectionIPAddressPreference.xml

…eference.xml Co-authored-by: Cheena Malhotra <v-chmalh@microsoft.com>

+ Disable TNIR in connection string

karinazhou added 5 commits March 23, 2021 18:01

Add IPAddressPreference net core

612f259

Merge branch 'main' of https://github.com/dotnet/SqlClient into IPAdd…

2314a55

…ressPreference

netcore SynonymCount update

b5c42ff

Add keyword in netfx

5ca9b4a

Add IP preference logic

444ab9b

karinazhou commented Mar 31, 2021

View reviewed changes

src/Microsoft.Data.SqlClient/netcore/src/Interop/SNINativeMethodWrapper.Windows.cs Show resolved Hide resolved

Fix incorrect description

ce608d3

David-Engel reviewed Apr 1, 2021

View reviewed changes

karinazhou and others added 3 commits April 7, 2021 19:24

Apply suggestions from code review

673dc39

Co-authored-by: David Engel <dengel1012@gmail.com>

Update DNS cache descripption

1f27eb7

Merge branch 'IPAddressPreference' of https://github.com/karinazhou/S…

5d42d26

…qlClient into IPAddressPreference

cheenamalhotra added the 🆕 Public API Use this label for new API additions to the driver. label Apr 9, 2021

cheenamalhotra added this to the 3.0.0-preview3 milestone Apr 9, 2021

johnnypham added 3 commits April 15, 2021 17:42

Merge remote-tracking branch 'upstream/main' into pr/1015

63d07bc

tests for ip address preference

37a0b77

Update SNITcpHandle.cs

0b6c0e4

Wraith2 reviewed Apr 19, 2021

View reviewed changes

src/Microsoft.Data.SqlClient/netcore/src/Microsoft/Data/SqlClient/SNI/SNITcpHandle.cs Outdated Show resolved Hide resolved

Update ConfigurableIpPreferenceTest.cs

8fa43b8

johnnypham reviewed Apr 23, 2021

View reviewed changes

src/Microsoft.Data.SqlClient/netcore/src/Microsoft/Data/SqlClient/SNI/SNITcpHandle.cs Outdated Show resolved Hide resolved

johnnypham and others added 4 commits April 23, 2021 12:47

Update src/Microsoft.Data.SqlClient/netcore/src/Microsoft/Data/SqlCli…

dfeea18

…ent/SNI/SNITcpHandle.cs

Improvement

b5a625b

Merge remote-tracking branch 'UpStream/main' into IPAddressPreference

0cf2304

# Conflicts: # src/Microsoft.Data.SqlClient/tests/ManualTests/Microsoft.Data.SqlClient.ManualTesting.Tests.csproj

Add new configurations

5642e74

DavoudEshtehari reviewed Apr 30, 2021

View reviewed changes

BUILDGUIDE.md Outdated Show resolved Hide resolved

Davoud Eshtehari added 2 commits April 30, 2021 15:45

Revert "Add new configurations"

e8b3ca4

This reverts commit 5642e74.

Update default config

ac69f38

DavoudEshtehari force-pushed the IPAddressPreference branch from fd6c475 to fb778fc Compare May 6, 2021 22:31

Add test

16935d4

DavoudEshtehari changed the title ~~WIP | Add IP address preference support for TCP connection~~ Add IP address preference support for TCP connection May 10, 2021

JRahnama reviewed May 11, 2021

View reviewed changes

DavoudEshtehari mentioned this pull request May 11, 2021

Fix | SqlClient-826 Missed synchronization #1029

Merged

cheenamalhotra reviewed May 11, 2021

View reviewed changes

Davoud Eshtehari and others added 2 commits May 11, 2021 10:36

Merge remote-tracking branch 'UpStream/main' into IPAddressPreference

ee3dbd3

Apply suggestions from code review

4a1d7f7

Co-authored-by: Javad <v-jarahn@microsoft.com> Co-authored-by: Cheena Malhotra <v-chmalh@microsoft.com>

Wraith2 reviewed May 11, 2021

View reviewed changes

src/Microsoft.Data.SqlClient/netcore/src/Microsoft/Data/Common/DbConnectionStringCommon.cs Outdated Show resolved Hide resolved

Wraith2 reviewed May 11, 2021

View reviewed changes

src/Microsoft.Data.SqlClient/netcore/src/Microsoft/Data/Common/DbConnectionStringCommon.cs Outdated Show resolved Hide resolved

JRahnama reviewed May 11, 2021

View reviewed changes

DavoudEshtehari force-pushed the IPAddressPreference branch from 7939ea3 to c41b411 Compare May 11, 2021 23:34

Address comments

c71143c

+ improvement

DavoudEshtehari force-pushed the IPAddressPreference branch from c41b411 to c71143c Compare May 11, 2021 23:42

Apply suggestions from code review

8464adb

Co-authored-by: Cheena Malhotra <v-chmalh@microsoft.com>

Wraith2 reviewed May 11, 2021

View reviewed changes

Address comments

ebbc42b

DavoudEshtehari reviewed May 13, 2021

View reviewed changes

src/Microsoft.Data.SqlClient/netcore/src/Resources/Strings.Designer.cs Outdated Show resolved Hide resolved

DavoudEshtehari reviewed May 13, 2021

View reviewed changes

src/Microsoft.Data.SqlClient/netfx/src/Resources/Strings.Designer.cs Outdated Show resolved Hide resolved

Apply suggestions from code review

12ff426

DavoudEshtehari force-pushed the IPAddressPreference branch from 1615eac to 12ff426 Compare May 13, 2021 01:35

JRahnama approved these changes May 13, 2021

View reviewed changes

Address comments

a2bc385

+ modify CancelAsyncConnections test

cheenamalhotra reviewed May 14, 2021

View reviewed changes

doc/snippets/Microsoft.Data.SqlClient/SqlConnectionIPAddressPreference.xml Show resolved Hide resolved

cheenamalhotra reviewed May 14, 2021

View reviewed changes

doc/snippets/Microsoft.Data.SqlClient/SqlConnectionIPAddressPreference.xml Show resolved Hide resolved

DavoudEshtehari and others added 2 commits May 14, 2021 12:31

Update doc/snippets/Microsoft.Data.SqlClient/SqlConnectionIPAddressPr…

0f27fde

…eference.xml Co-authored-by: Cheena Malhotra <v-chmalh@microsoft.com>

Address comments

019fce0

+ Disable TNIR in connection string

DavoudEshtehari force-pushed the IPAddressPreference branch from 5e5f4ce to 019fce0 Compare May 14, 2021 23:24

cheenamalhotra approved these changes May 15, 2021

View reviewed changes

cheenamalhotra merged commit 561b535 into dotnet:main May 17, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add IP address preference support for TCP connection #1015

Add IP address preference support for TCP connection #1015

karinazhou commented Mar 31, 2021 •

edited

Loading

Wraith2 commented Apr 2, 2021

Wraith2 May 11, 2021

Add IP address preference support for TCP connection #1015

Add IP address preference support for TCP connection #1015

Conversation

karinazhou commented Mar 31, 2021 • edited Loading

Wraith2 commented Apr 2, 2021

Wraith2 May 11, 2021

Choose a reason for hiding this comment

karinazhou commented Mar 31, 2021 •

edited

Loading